Skip to content

docs: README を英語版にし、日本語版を README.ja.md として残す - #132

Merged
takecchi merged 1 commit into
mainfrom
codiva/readme-readme-readme
Aug 21, 2026
Merged

docs: README を英語版にし、日本語版を README.ja.md として残す#132
takecchi merged 1 commit into
mainfrom
codiva/readme-readme-readme

Conversation

@takecchi

Copy link
Copy Markdown
Owner

概要

npm / GitHub の顔になる README.md英語にし、これまでの日本語の内容は README.ja.md として残しました。両方の冒頭でお互いを案内しています。

  • git mv README.md README.ja.md → 新規に英語版 README.md を作成(履歴は追えます)
  • 英訳は全節(特徴 / 動作要件 / インストール / 使い方 / キー操作 / PR ステータス / /sync/fix-ci / プラン・使用状況 / /agent とエージェント差 / 設定全キー / トラブルシューティング / 開発 / リリース)
  • README.md 冒頭: **日本語のドキュメントは [README.ja.md](./README.ja.md) にあります。**
  • README.ja.md 冒頭: **このページは日本語版です。English documentation is available in [README.md](./README.md).**

ドキュメント運用

日本語(README.ja.md)を原本、英語(README.md)をその訳として扱い、ユーザー可視の変更では2 ファイル対で更新する方針を明記しました。

  • README.ja.md の「開発」節に原本・訳の関係を注記
  • .claude/rules/workflow.md のドキュメント役割分担の表と「変更時に一緒に更新するもの」チェックリスト
  • .claude/skills/add-config-option/SKILL.md(設定表)と .claude/skills/add-slash-command/SKILL.md(コマンド説明)のチェックリスト

docs/.claude/ は現状日本語のみで、これは README にも注記してあります。

補足

  • package.jsonfiles["dist"] のままです(npm は README.md を常に同梱するので、npm ページは英語になります。README.ja.md は GitHub 側のリンクで辿ります)。
  • 内部アンカーリンクは英語見出しに合わせて張り替えてあります(#choosing-and-switching-agents-agent / #changing-settings-from-the-ui-config)。

テスト

  • 英語版に日本語の混入がないことを確認(意図的な案内 1 行のみ)
  • 見出し一覧とアンカーリンクの整合を確認
  • CI(lint / typecheck / test / build)— コード変更はなし

npm / GitHub の顔になる README.md を英語にして、日本語の内容は
README.ja.md へ退避した(`git mv` なので履歴は追える)。

- README.md: 全節を英訳。冒頭に日本語版への案内を置く
- README.ja.md: 冒頭に英語版への案内、開発節に「日本語が原本・英語は対で更新」を明記
- .claude/rules/workflow.md / add-config-option / add-slash-command:
  ユーザー可視の変更では README を 2 ファイル対で更新するようチェックリストを修正
@takecchi
takecchi merged commit d3a5475 into main Aug 21, 2026
1 check passed
@takecchi
takecchi deleted the codiva/readme-readme-readme branch August 21, 2026 04:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant